Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial documentation site/skeleton #7

Merged
merged 4 commits into from
Sep 1, 2020
Merged

Initial documentation site/skeleton #7

merged 4 commits into from
Sep 1, 2020

Conversation

amyreese
Copy link
Member

Uses sphinx with the Alabaster theme, mostly copy-pasta'd from
aiosqlite. Includes the readme, changelog, contributing guide, and
code of conduct from the base repo. The FB Open Source logo needs
a version that is meant for use on light/white backgrounds.

Build the docs using make html from within the virtualenv.

Better readme/user guide to be done in separate diffs.

@amyreese
Initial documentation site/skeleton
83ecc22 
Uses sphinx with the Alabaster theme, mostly copy-pasta'd from
aiosqlite. Includes the readme, changelog, contributing guide, and
code of conduct from the base repo. The FB Open Source logo needs
a version that is meant for use on light/white backgrounds.

Build the docs using `make html` from within the virtualenv.

Better readme/user guide to be done in separate diffs.
@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 26, 2020
@amyreese
Copy link
Member Author

In some of my other projects, I've had make html automatically create/source the virtualenv, so that it can be used without already having the virtualenv sourced. Would you be ok with that here as well?

Also, thoughts on adding a make html step to the CI, or just wait until we get read-the-docs hooked up and test out its new Github/CI integration?

@thatch
Copy link
Contributor

thatch commented Aug 26, 2020

  • automatic build of venv: if it's not too complex, go for it. (how do you detect whether you're in a venv?)
  • make CI run this: definitely, but don't bother to store it. I would rather just serve from RTD.

thatch
thatch reviewed Aug 26, 2020
View reviewed changes
Makefile Outdated Show resolved Hide resolved
thatch
thatch reviewed Aug 26, 2020
View reviewed changes
requirements-dev.txt Outdated Show resolved Hide resolved
@amyreese
Address feedback
711b265 
* `make html` will build and use venv even if not activated
* CI will run `make html`
* pinned m2r requirement to latest upstream rev
@amyreese amyreese requested a review from thatch August 26, 2020 18:28
@thatch
Copy link
Contributor

thatch commented Aug 26, 2020

I don't expect you to solve the great "." vs "source" debate here, but can you try to get the makefile working with non-zsh (or remove that step from CI for now)

@thatch thatch merged commit c09a94a into master Sep 1, 2020
@amyreese amyreese deleted the docs branch October 11, 2021 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thatch thatch Awaiting requested review from thatch

Assignees
No one assigned
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@amyreese @thatch @facebook-github-bot